Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tsdoc for refetch, fetchMore and other returned values for suspense hooks #11394

Closed
wants to merge 6 commits into from
Closed

Add tsdoc for refetch, fetchMore and other returned values for suspense hooks #11394

wants to merge 6 commits into from

Conversation

jerelmiller
Copy link
Member

Adds tsdoc comments to the result objects returned from our existing suspense hooks.

Original ask:

@jerelmiller jerelmiller requested a review from phryneas November 29, 2023 04:47
@jerelmiller jerelmiller requested a review from a team as a code owner November 29, 2023 04:47
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 29, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 746b3ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jerelmiller jerelmiller changed the base branch from main to release-3.9 November 29, 2023 04:48
@netlify Netlify
Copy link

netlify bot commented Nov 29, 2023

✅ Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 9c05d09
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/6566c276a049d800081888f3
😎 Deploy Preview https://deploy-preview-11394--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

phryneas
phryneas approved these changes Nov 29, 2023
View reviewed changes
Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvement!

Do you think it makes sense to split it up into 2 PRs and get most of this into main?

@github-actions github-actions bot added the auto-cleanup 🤖 label Nov 29, 2023
@github-actions GitHub Actions
Copy link
Contributor

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 37.72 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 44.2 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 42.68 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 32.79 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.46 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.28 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.26 KB (0%)
import { useQuery } from "dist/react/index.js" 4.38 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.19 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 4.69 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.51 KB (0%)
import { useMutation } from "dist/react/index.js" 2.65 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.63 KB (0%)
import { useSubscription } from "dist/react/index.js" 2.34 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 2.29 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 4.37 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 3.79 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 3.86 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.27 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 4.12 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.53 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.05 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3 KB (0%)
import { useFragment } from "dist/react/index.js" 2.15 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.1 KB (0%)

@phryneas
Copy link
Member

PS: there is slight overlap with https://github.com/apollographql/apollo-client/pull/11381/files#diff-61523aec6529faa71ab822ab03e00aa48743ebf5c156794ed907f2765e00d5f2 - feel free to steal anything from there if you want to. I'm happy to get any changes in here and remove them from that one :)

@jerelmiller
Copy link
Member Author

@phryneas let's use your PR. I can update anything in here after that one is merged to main and pulled up into release-3.9.

@jerelmiller
Copy link
Member Author

Do you think it makes sense to split it up into 2 PRs and get most of this into main?

Oops, just noticed this. Actually this is a great idea! I'll open a new PR based off main to make this work and close this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 30, 2023
@jerelmiller jerelmiller deleted the jerel/ts-docs-fetchmore branch January 31, 2024 23:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@phryneas phryneas phryneas approved these changes

Assignees
No one assigned
Labels
auto-cleanup 🤖
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jerelmiller @phryneas